GET Users?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves users for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
take |
Number of users to retrieve. Default is all users |
integer |
None. |
skip |
Number of users to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the users before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of users.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "UserId": "c3af05a0-3e2f-460d-804a-4b5d0e534d9f", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "fa006e77-2786-4f20-8d39-5efade6375f8", "Teams": [ { "TeamId": "0118794e-3c5e-4677-aaaa-81c41aec3e63", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ef8c5471-2dfd-459a-932e-4e923720d67d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "0118794e-3c5e-4677-aaaa-81c41aec3e63", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ef8c5471-2dfd-459a-932e-4e923720d67d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ] }, { "UserId": "c3af05a0-3e2f-460d-804a-4b5d0e534d9f", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "fa006e77-2786-4f20-8d39-5efade6375f8", "Teams": [ { "TeamId": "0118794e-3c5e-4677-aaaa-81c41aec3e63", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ef8c5471-2dfd-459a-932e-4e923720d67d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "0118794e-3c5e-4677-aaaa-81c41aec3e63", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4e1b4810-a057-46c8-91f9-5c020a8c83fb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "MeasurementValueNeededDate": "2024-04-29T00:48:54.3623738-07:00", "SourceSystemId": "sample string 3", "CompanyId": "febcec91-44bb-4a9f-b561-8f9ec3039e4d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ef8c5471-2dfd-459a-932e-4e923720d67d", "CreateDate": "2024-04-29T00:48:54.3623738-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-29T00:48:54.3623738-07:00", "LastModifiedUser": "sample string 6" } ] } ], "Total": 1, "Message": "sample string 1" }